<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dpdma: xdpdma_video_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dpdma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdpdma__video__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdpdma_video_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the DPDMA driver (XDpDma) This example demonstrates the use of DPDMA for displaying a Graphics Overlay. </p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>None.</p>
<pre>
 MODIFICATION HISTORY:</pre><pre> Ver   Who Date     Changes
</p>
<hr/>
<p>
 1.0    aad 10/19/17    Initial Release
 1.1   aad 02/22/18    Fixed the header
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the DPDMA Video example.  <a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br/></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab82447645e4ec0a18dfe90d74018a8a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample</a> (Run_Config *RunCfgPtr)</td></tr>
<tr class="memdesc:ab82447645e4ec0a18dfe90d74018a8a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to illustrate how to use the XDpDma device driver in Graphics overlay mode.  <a href="#ab82447645e4ec0a18dfe90d74018a8a1">More...</a><br/></td></tr>
<tr class="separator:ab82447645e4ec0a18dfe90d74018a8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1feaf56ba2ce7c1f4770cbab7da31276"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#a1feaf56ba2ce7c1f4770cbab7da31276">InitRunConfig</a> (Run_Config *RunCfgPtr)</td></tr>
<tr class="memdesc:a1feaf56ba2ce7c1f4770cbab7da31276"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to initialize the application configuration.  <a href="#a1feaf56ba2ce7c1f4770cbab7da31276">More...</a><br/></td></tr>
<tr class="separator:a1feaf56ba2ce7c1f4770cbab7da31276"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80296bbf6ce18bd52a48ac07844ec8ea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#a80296bbf6ce18bd52a48ac07844ec8ea">InitDpDmaSubsystem</a> (Run_Config *RunCfgPtr)</td></tr>
<tr class="memdesc:a80296bbf6ce18bd52a48ac07844ec8ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to initialize the DP Subsystem (XDpDma, XAVBuf, XDpPsu)  <a href="#a80296bbf6ce18bd52a48ac07844ec8ea">More...</a><br/></td></tr>
<tr class="separator:a80296bbf6ce18bd52a48ac07844ec8ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6be070431bed335091e0e9feb7bea7ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#a6be070431bed335091e0e9feb7bea7ac">SetupInterrupts</a> (Run_Config *RunCfgPtr)</td></tr>
<tr class="memdesc:a6be070431bed335091e0e9feb7bea7ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to setup call back functions for the DP controller interrupts.  <a href="#a6be070431bed335091e0e9feb7bea7ac">More...</a><br/></td></tr>
<tr class="separator:a6be070431bed335091e0e9feb7bea7ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d2377e33548dca5990bc7068593b8ba"><td class="memItemLeft" align="right" valign="top">u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdpdma__video__example_8c.html#a8d2377e33548dca5990bc7068593b8ba">GraphicsOverlay</a> (u8 *Frame, Run_Config *RunCfgPtr)</td></tr>
<tr class="memdesc:a8d2377e33548dca5990bc7068593b8ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to generate a Graphics frame of the format RGBA8888 which generates an overlay on 1/2 of the bottom of the screen.  <a href="#a8d2377e33548dca5990bc7068593b8ba">More...</a><br/></td></tr>
<tr class="separator:a8d2377e33548dca5990bc7068593b8ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ab82447645e4ec0a18dfe90d74018a8a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int DpdmaVideoExample </td>
          <td>(</td>
          <td class="paramtype">Run_Config *&#160;</td>
          <td class="paramname"><em>RunCfgPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to illustrate how to use the XDpDma device driver in Graphics overlay mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RunCfgPtr</td><td>is a pointer to the application configuration structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, else XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdpdma__video__example_8c.html#a8d2377e33548dca5990bc7068593b8ba">GraphicsOverlay()</a>, <a class="el" href="xdpdma__video__example_8c.html#a80296bbf6ce18bd52a48ac07844ec8ea">InitDpDmaSubsystem()</a>, <a class="el" href="xdpdma__video__example_8c.html#a1feaf56ba2ce7c1f4770cbab7da31276">InitRunConfig()</a>, and <a class="el" href="xdpdma__video__example_8c.html#a6be070431bed335091e0e9feb7bea7ac">SetupInterrupts()</a>.</p>

<p>Referenced by <a class="el" href="xdpdma__video__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a8d2377e33548dca5990bc7068593b8ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8* GraphicsOverlay </td>
          <td>(</td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>Frame</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Run_Config *&#160;</td>
          <td class="paramname"><em>RunCfgPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to generate a Graphics frame of the format RGBA8888 which generates an overlay on 1/2 of the bottom of the screen. </p>
<p>This is just to illustrate the functionality of the graphics overlay.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RunCfgPtr</td><td>is a pointer to the application configuration structure. </td></tr>
    <tr><td class="paramname">Frame</td><td>is a pointer to a buffer which is going to be populated with rendered frame</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a pointer to the frame.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xdpdma__video__example_8h.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a80296bbf6ce18bd52a48ac07844ec8ea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int InitDpDmaSubsystem </td>
          <td>(</td>
          <td class="paramtype">Run_Config *&#160;</td>
          <td class="paramname"><em>RunCfgPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to initialize the DP Subsystem (XDpDma, XAVBuf, XDpPsu) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RunCfgPtr</td><td>is a pointer to the application configuration structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdpdma_8c.html#a644e1a27df9327819d6fce610e97bae1">XDpDma_CfgInitialize()</a>, <a class="el" href="group__dpdma__v1__4.html#ga45c3b90c332325198b482ac90809695a">XDpDma_LookupConfig()</a>, <a class="el" href="xdpdma_8c.html#a3307b5795328ef76c76674588918739d">XDpDma_SetGraphicsFormat()</a>, and <a class="el" href="xdpdma_8c.html#ac04dd8bf90f181c5ca44af2b0bd1e3d2">XDpDma_SetQOS()</a>.</p>

<p>Referenced by <a class="el" href="xdpdma__video__example_8h.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample()</a>, and <a class="el" href="xdppsu__interrupt_8c.html#a51529144f29c6d0db501353f1082d7cd">DpPsu_Run()</a>.</p>

</div>
</div>
<a class="anchor" id="a1feaf56ba2ce7c1f4770cbab7da31276"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void InitRunConfig </td>
          <td>(</td>
          <td class="paramtype">Run_Config *&#160;</td>
          <td class="paramname"><em>RunCfgPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to initialize the application configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RunCfgPtr</td><td>is a pointer to the application configuration structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xdpdma__video__example_8h.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the DPDMA Video example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xdpdma__video__example_8c.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a6be070431bed335091e0e9feb7bea7ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SetupInterrupts </td>
          <td>(</td>
          <td class="paramtype">Run_Config *&#160;</td>
          <td class="paramname"><em>RunCfgPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to setup call back functions for the DP controller interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RunCfgPtr</td><td>is a pointer to the application configuration structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdpdma__video__example_8h.html#a601d86ab0c289a1eec2bacc241a3df06">DpPsu_IsrHpdEvent()</a>, <a class="el" href="xdpdma__video__example_8h.html#adbfe5ef0bf4ee5c6cd11a276a48724a2">DpPsu_IsrHpdPulse()</a>, <a class="el" href="xdpdma__intr_8c.html#a1789f821f2b216d7693514352b300216">XDpDma_InterruptEnable()</a>, and <a class="el" href="xdpdma__intr_8c.html#a856c484c8e45df996ba6aa97f38392dd">XDpDma_InterruptHandler()</a>.</p>

<p>Referenced by <a class="el" href="xdpdma__video__example_8h.html#ab82447645e4ec0a18dfe90d74018a8a1">DpdmaVideoExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
